Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(GHA): small updates #468

Merged
merged 6 commits into from
Mar 7, 2022
Merged

docs(GHA): small updates #468

merged 6 commits into from
Mar 7, 2022

Conversation

kanadgupta
Copy link
Member

🧰 Changes

Closes #467

  • Update a link in README.md to point to the correct section of our docs
  • Expand on GHA version guidance in README.md to talk about why we want the user to fix the version
  • Fix the markdown frontmatter examples in rdme.md to reflect the actual frontmatter of that page
  • Flip the OpenAPI and Markdown syncing examples since our OpenAPI syncing is more feature-complete
  • Some tweaks in the Markdown syncing example (language updates, link fixes, more emojis)

🧬 QA & Testing

Just doc updates, so feel free to just gloss everything over! If you're curious about the actual diff in the Markdown syncing example, see this commit: b2966f1

@kanadgupta kanadgupta added this to the v7 milestone Mar 7, 2022
@kanadgupta kanadgupta added the documentation Improvements or additions to documentation label Mar 7, 2022
@kanadgupta kanadgupta marked this pull request as ready for review March 7, 2022 15:26
@kanadgupta kanadgupta requested a review from erunion March 7, 2022 15:26
After thinking about it a little bit more, I think it makes more sense for the user to view the docs on `main`, versus on the latest tag. Our docs sync with every push to `main` and we should probably version them so they're better tied to version tags (i.e. they're only published when we bump versions), but I think this is the more intuitive solution for now.
@kanadgupta kanadgupta merged commit f05d8f1 into main Mar 7, 2022
@kanadgupta kanadgupta deleted the doc-touch-ups branch March 7, 2022 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs touch-ups
2 participants